<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
	<!--[if lt IE 9]>
	<script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
	<![endif]-->
    <title>Release_V1 - Pws.Clients.RestLibrary Documentation</title>
    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
    <link type="text/css" rel="stylesheet" href="../main.css"/>
    <script type="text/javascript" src="../js/jquery-1.3.2.min.js"></script>
    <script type="text/javascript" src="../js/jquery.scrollTo-min.js"></script>
    <script type="text/javascript" src="../js/navigation.js"></script>
    <script type="text/javascript" src="../js/example.js"></script>
  </head>
  <body>
  	<header><h1>Pws.Clients.RestLibrary : API Documentation</h1>
	</header>
<nav id="namespaces">
	<h2 class="fixed">Namespaces</h2>
	<div class="scroll">
		<ul>
			<li>
          <a href="../Pws.Clients.RestLibrary/index.htm">Pws.Clients.RestLibrary</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Aftersales/index.htm">Pws.Clients.RestLibrary.Aftersales</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Customers/index.htm">Pws.Clients.RestLibrary.Customers</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Customers.Contacts/index.htm">Pws.Clients.RestLibrary.Customers.Contacts</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Customers.Orders/index.htm" class="current">Pws.Clients.RestLibrary.Customers.Orders</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Customers.Products/index.htm">Pws.Clients.RestLibrary.Customers.Products</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.ECommerce.Permissions/index.htm">Pws.Clients.RestLibrary.ECommerce.Permissions</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.ECommerce.Users/index.htm">Pws.Clients.RestLibrary.ECommerce.Users</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Framework/index.htm">Pws.Clients.RestLibrary.Framework</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Products/index.htm">Pws.Clients.RestLibrary.Products</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Products.Navigation/index.htm">Pws.Clients.RestLibrary.Products.Navigation</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Shared/index.htm">Pws.Clients.RestLibrary.Shared</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Suppliers/index.htm">Pws.Clients.RestLibrary.Suppliers</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.WorksurfaceEstimator/index.htm">Pws.Clients.RestLibrary.WorksurfaceEstimator</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.WorksurfaceJobs/index.htm">Pws.Clients.RestLibrary.WorksurfaceJobs</a>
      </li>
		</ul>
	</div>
</nav><nav id="types">
  <h2 class="fixed">Types in Pws.Clients.RestLibrary.Customers.Orders</h2>
	<div class="scroll">
		<ul>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/Alert_V1.htm">Alert_V1</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/BespokeOption.htm">BespokeOption</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/BespokeQuantityDefault.htm">BespokeQuantityDefault</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/BespokeSelection.htm">BespokeSelection</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/CurrencyAmount.htm">CurrencyAmount</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/CurrencyAmountWithVat.htm">CurrencyAmountWithVat</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/DispatchMethod_V1.htm">DispatchMethod_V1</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/Event.htm">Event</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/Fulfilment.htm">Fulfilment</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm">Order_V1</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/OrderLine_V1.htm">OrderLine_V1</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/OrderLine_V2.htm">OrderLine_V2</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/ProductPrice.htm">ProductPrice</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/Progression_V1.htm">Progression_V1</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/Release_V1.htm" class="current">Release_V1</a>
        </li>
		</ul>
	</div>
</nav>
	<article>
    <header>
		<p class="class"><strong>Type</strong> Release_V1</p>
	</header>
	<section>
		<header>
		<p><strong>Namespace</strong> Pws.Clients.RestLibrary.Customers.Orders</p>
		<p><strong>Interfaces</strong> <a href="../Pws.Clients.RestLibrary/IPwsObject_V1.htm">IPwsObject_V1</a></p>
		</header>
    <div class="sub-header">
			<div id="summary">Instruct that a sales order should be released for credit checks, or that a card payment has been made
so it can be released to pick. <blockquote class="remarks">
  application/x.pws.customers.orders.release-v1 
</blockquote>
			</div>
		
		
		
			<h3 class="section">Properties</h3>
			<ul>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Release_V1.htm#ExternalPaymentAuthorisationCode">ExternalPaymentAuthorisationCode</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Release_V1.htm#ExternalPaymentAuthorisedAmount">ExternalPaymentAuthorisedAmount</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Release_V1.htm#ExternalPaymentPayerAddress">ExternalPaymentPayerAddress</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Release_V1.htm#ExternalPaymentPayerName">ExternalPaymentPayerName</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Release_V1.htm#ExternalPaymentPayerReference">ExternalPaymentPayerReference</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Release_V1.htm#ExternalPaymentProviderMessage">ExternalPaymentProviderMessage</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Release_V1.htm#ExternalPaymentProviderStatusCode">ExternalPaymentProviderStatusCode</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Release_V1.htm#IsExternalPaymentAuthorised">IsExternalPaymentAuthorised</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Release_V1.htm#IsExternalPaymentMethod">IsExternalPaymentMethod</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Release_V1.htm#Links">Links</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Release_V1.htm#Orders">Orders</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Release_V1.htm#PaymentAmount">PaymentAmount</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Release_V1.htm#PaymentCurrencyCode">PaymentCurrencyCode</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Release_V1.htm#PaymentInternalReference">PaymentInternalReference</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Release_V1.htm#PaymentType">PaymentType</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Release_V1.htm#ReleaseDescription">ReleaseDescription</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Release_V1.htm#ReleaseMessage">ReleaseMessage</a></li>
			</ul>
		
	</div>
	
	
	
	<h3 class="section">Public properties</h3>

	<div id="ExternalPaymentAuthorisationCode" class="method">
		<h4>
			<span title="System.string">string</span> <strong>ExternalPaymentAuthorisationCode</strong> get; set;
		</h4>
		<div class="content">If external payment is taken, then this is the authorisation code from the external card payment provider. 

		</div>
	</div>
	<div id="ExternalPaymentAuthorisedAmount" class="method">
		<h4>
			<span title="System.double">double</span> <strong>ExternalPaymentAuthorisedAmount</strong> get; set;
		</h4>
		<div class="content">If external payment is taken, then this is the financial amount (in whatever currency) that
the payment provider confirmed as being authorised. 

		</div>
	</div>
	<div id="ExternalPaymentPayerAddress" class="method">
		<h4>
			<span title="System.string">string</span> <strong>ExternalPaymentPayerAddress</strong> get; set;
		</h4>
		<div class="content">If external payment is taken, then this is the cardholder's address. 

		</div>
	</div>
	<div id="ExternalPaymentPayerName" class="method">
		<h4>
			<span title="System.string">string</span> <strong>ExternalPaymentPayerName</strong> get; set;
		</h4>
		<div class="content">If external payment is taken, then this is the cardholder's name. 

		</div>
	</div>
	<div id="ExternalPaymentPayerReference" class="method">
		<h4>
			<span title="System.string">string</span> <strong>ExternalPaymentPayerReference</strong> get; set;
		</h4>
		<div class="content">A code returned by the payment provider relating to the payer, e.g. card type and last four digits. 

		</div>
	</div>
	<div id="ExternalPaymentProviderMessage" class="method">
		<h4>
			<span title="System.string">string</span> <strong>ExternalPaymentProviderMessage</strong> get; set;
		</h4>
		<div class="content">Any message that the payment provider has returned. 

		</div>
	</div>
	<div id="ExternalPaymentProviderStatusCode" class="method">
		<h4>
			<span title="System.string">string</span> <strong>ExternalPaymentProviderStatusCode</strong> get; set;
		</h4>
		<div class="content">A code returned by the payment provider indicating the success or failure status of the payment. 

		</div>
	</div>
	<div id="IsExternalPaymentAuthorised" class="method">
		<h4>
			<span title="System.bool">bool</span> <strong>IsExternalPaymentAuthorised</strong> get; set;
		</h4>
		<div class="content">Set this to true if this is an IsExternalPaymentMethod, and if that external payment method (e.g. card payment) was
successful. 

		</div>
	</div>
	<div id="IsExternalPaymentMethod" class="method">
		<h4>
			<span title="System.bool">bool</span> <strong>IsExternalPaymentMethod</strong> get; set;
		</h4>
		<div class="content">If this is true, then the client is assumed to be making the external payment. E.g. card payment, paypal, etc.
In this case, set the IsExternalPaymentAuthorised to true when Posting the object back to the order (if external payment was
successful). 

		</div>
	</div>
	<div id="Links" class="method">
		<h4>
			<span title="System.Collections.Generic.List<Link_V1>">List&lt;Link_V1&gt;</span> <strong>Links</strong> get; set;
		</h4>
		<div class="content">

		</div>
	</div>
	<div id="Orders" class="method">
		<h4>
			<span title="System.Collections.Generic.List<string>">List&lt;string&gt;</span> <strong>Orders</strong> get; set;
		</h4>
		<div class="content">A list of orders for which payment is being taken. Do not alter this. <blockquote class="remarks">
  Required. 
</blockquote>

		</div>
	</div>
	<div id="PaymentAmount" class="method">
		<h4>
			<span title="System.decimal">decimal</span> <strong>PaymentAmount</strong> get; set;
		</h4>
		<div class="content">The amount that is required of this payment. Do not alter this. <blockquote class="remarks">
  Required. 
</blockquote>

		</div>
	</div>
	<div id="PaymentCurrencyCode" class="method">
		<h4>
			<span title="System.string">string</span> <strong>PaymentCurrencyCode</strong> get; set;
		</h4>
		<div class="content">The currency code that the PaymentAmount is in. Do not alter this. <blockquote class="remarks">
  Required. 
</blockquote>

		</div>
	</div>
	<div id="PaymentInternalReference" class="method">
		<h4>
			<span title="System.string">string</span> <strong>PaymentInternalReference</strong> get; set;
		</h4>
		<div class="content">The PWS internal payment reference. Do not alter this. This can be used for the external reference, e.g.
it can be sent to the external payment resource such as a card payment routine. <blockquote class="remarks">
  Required. 
</blockquote>

		</div>
	</div>
	<div id="PaymentType" class="method">
		<h4>
			<span title="System.string">string</span> <strong>PaymentType</strong> get; set;
		</h4>
		<div class="content">The PWS internal payment type identifier. Do not alter this. Although the value in this field is primarily for PWS
use only (and therefore might change in future); in the case of external payment methods there are reserved keywords
which the client can look for, which have special meanings for external payment methods. These are: Mastercard, Visa, VisaDelta. <blockquote class="remarks">
  Required. 
</blockquote>

		</div>
	</div>
	<div id="ReleaseDescription" class="method">
		<h4>
			<span title="System.string">string</span> <strong>ReleaseDescription</strong> get; set;
		</h4>
		<div class="content">Human readable description of the particular release method. 
<div class="example">
  <a href="javascript:void(0)">Show Example</a>
  <pre>Pay up front on a credit card. </pre>
</div>
		</div>
	</div>
	<div id="ReleaseMessage" class="method">
		<h4>
			<span title="System.string">string</span> <strong>ReleaseMessage</strong> get; set;
		</h4>
		<div class="content">Any important notes for the customer that may or maynot be related to the release type. 
<div class="example">
  <a href="javascript:void(0)">Show Example</a>
  <pre>A customer representative will call you to arrange a suitable date and time for collection. </pre>
</div>
		</div>
	</div>
	</section>
	</article><footer>
	<span id="version">Built from v1.0.0.0 of Pws.Clients.RestLibrary</span>
	<span id="docu-link">
		Generated by <a href="http://docu.jagregory.com">docu</a>
	</span>
</footer>
  </body>
</html>